cs-credits-sapi

(0 reviews)

📚 Data Dictionary - CS Credits System API (SAPI)

This section provides the meaning of the attributes included in the API.

"Authorization": "Bearer {{API_KEY}}"Attribute defined in the request Header.
- Type: String
- Length: Minimum 36 characters, maximum 37 characters
- Description: Authentication token required to access the API.
"client_id": "{{CLIENT_ID}}"Attribute defined in the request Header.
- Type: String
- Length: Minimum 32 characters, maximum 36 characters
- Description: Unique client identifier to authenticate the request.

NOTE: It is important to have these API KEYS to make any request to our services.

"idRequest"
- Type: Number
- Description: Unique identifier for the credit insurance request.
- Example: 255025
"status"
- Type: String
- Description: The current status of the credit insurance.
- Allowed Values: pending, approved, rejected

"idRequest"
- Type: Number
- Description: Unique identifier for the credit insurance request (path parameter).
- Example: 255025
"status"
- Type: String
- Description: New status to be updated for the request.
- Allowed Values: pending, approved, rejected
"comments"
- Type: String
- Description: Optional comments regarding the status update.
- Max Length: 250 characters

Parameter	Type	Description	Required
`client_id`	`string`	Unique identifier for API clients	✅
`Authorization`	`string`	Bearer token for secure access	✅
`idRequest`	`number`	Unique ID for credit insurance request	✅
`status`	`string`	Status of the insurance request	✅ (for PUT requests)
`comments`	`string`	Additional notes or remarks	Optional

Field	Type	Required	Length (characters)	RegEx
`client_id`	String	Yes	32 - 36	`[a-zA-Z0-9]`
`client_secret`	String	Yes	32 - 64	`[a-zA-Z0-9]`

Field	Type	Required	Length (characters)	RegEx
`Authorization`	String	Yes	36 - 37	`[a-zA-Z0-9-_.]`

Code	Description	Suggested Solution
400	Bad Request	Verify the request structure.
401	Unauthorized	Check the authentication credentials.
404	Not Found	Ensure the endpoint is correct.
500	Internal Server Error	Try again later or contact support.

For any questions or issues, please contact the API support team COORDINACION DESARROLLO DE SERVICIOS Y APLICACIONES DE INTEGRACIONES.